package top.lixunda.ecommerce.server.good.api.controller;

import com.baomidou.mybatisplus.core.metadata.IPage;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;
import top.lixunda.commerce.common.core.entity.MessageObject;
import top.lixunda.common.validate.XumValid;
import top.lixunda.ecommerce.server.business.api.entity.dto.PageDTO;
import top.lixunda.ecommerce.server.good.api.entity.db.StoreDO;
import top.lixunda.ecommerce.server.good.api.entity.dto.StoreInfoQueryDTO;
import top.lixunda.ecommerce.server.good.api.entity.vo.StoreInfoVO;

import java.util.List;

/**
 * 店铺基本信息
 *
 * @author Xumda
 * @version time:2020/1/18 15:19
 */
@SuppressWarnings("unused")
@Api("店铺基本信息")
@RequestMapping("/store")
public interface IStoreController {

    /**
     * 根据id查询店铺信息，必须存在，否则抛出异常
     *
     * @param id 店铺id，不能为空，大于零的数字
     * @return 店铺基本数据
     */
    @ApiOperation("根据id查询店铺信息，必须存在，否则抛出异常")
    @GetMapping("queryStoreInfoById")
    MessageObject<StoreInfoVO> queryStoreInfoById(@RequestParam("id") Integer id);

    /**
     * 根据多个id查询店铺数据
     *
     * @param ids 店铺id数组，单个id为大于零的数字
     * @return 店铺基本数据列表，返回查询到的店铺信息，没查到不会抛出异常
     */
    @ApiOperation("根据多个id查询店铺数据")
    @PostMapping("queryStoreInfoByIds")
    MessageObject<List<StoreInfoVO>> queryStoreInfoByIds(@RequestBody List<Integer> ids);

    /**
     * 条件分页查询店铺基本信息
     *
     * @param pageDTO 分页条件和查询条件
     * @return 分页数据
     */
    @ApiOperation("条件分页查询店铺基本信息")
    @PostMapping("queryStoreInfoByPageWrapper")
    MessageObject<IPage<StoreInfoVO>> queryStoreInfoByPageWrapper(
            @XumValid @RequestBody PageDTO<StoreDO, StoreInfoQueryDTO> pageDTO);

    /**
     * Admin权限，条件分页查询店铺基本信息
     *
     * @param pageDTO 分页条件和查询条件
     * @return 分页数据
     */
    @ApiOperation("Admin权限，条件分页查询店铺基本信息")
    @PostMapping("queryAdminInfoByPageWrapper")
    MessageObject<IPage<StoreInfoVO>> queryAdminInfoByPageWrapper(
            @XumValid @RequestBody PageDTO<StoreDO, StoreInfoQueryDTO> pageDTO);

    /**
     * 根据店铺名称精确查询店铺信息，不存在会返回错误信息
     *
     * @param name 店铺名称，长度大于0的字符串
     * @return 店铺数据
     */
    @ApiOperation("根据店铺名称精确查询店铺信息，不存在会返回错误信息")
    @GetMapping("queryStoreInfoByName")
    MessageObject<StoreInfoVO> queryStoreInfoByName(@RequestParam("name") String name);
}
